RMS Config API
API Resources
The Remote Managed Services API allows you to:
• Review and change the configuration of Gateway, WiFi, Voice, LAN, & Security services on ONT’s
• Manage the assurance journey of the Gateway, WiFi, Voice, LAN, & Security services troubleshooting and resolving service issues
• Reset and restart services and the ONT
The Remote Managed Services API includes the following resources:
| Name | Function | HTTP method |
|---|---|---|
| Get API version/Test API connectivity | GET | /version |
| Get list of Remote Management Service details associated with a product ID | GET | /services/{productid} |
| Factory Reset Device | POST | /services/{productid}/factoryReset |
| Reboot Device | POST | /services/{productid}/reboot |
| Get WAN configuration and/or statistics | GET | /services/{productId}/wan |
| Set WAN configuration | PUT | /services/{productId}/wan |
| Get LAN Ethernet ports configuration and/or Ethernet ports statistics | GET | /services/{productId}/lan/ethernetPorts |
| Put LAN Ethernet port configuration | PUT | /services/{productId}/lan/ethernetPorts/{ethernetPortIndex} |
| Get LAN DHCP & IP configuration | GET | /services/{productId}/lan/dhcpIp |
| Set LAN DHCP & IP configuration | PUT | /services/{productId}/lan/dhcpIp |
| Get LAN Static IP Address configuration | GET | /services/{productId}/lan/staticIps |
| Set LAN Static IP Address configuration | PUT | /services/{productId}/lan/staticIps |
| Get LAN hosts information | GET | /services/{productId}/lan/hosts |
| Reset a LAN Ethernet port | POST | /services/{productId}/lan/ethernetPorts/{ethernetPortIndex}/reset |
| Get WiFi ports configuration, port statistics, devices, and /or device statistics information | GET | /services/{productId}/wifi |
| Set WiFi port configuration | PUT | /services/{productId}/wifi/{wifiPortIndex} |
| Reset a WiFi port | POST | /services/{productId}/wifi/{wifiPortIndex}/reset |
| Get voice profiles and/or ports configuration, and/or port statistics information | GET | /services/{productid}/voice |
| Set voice profile configuration | PUT | /services/{productid}/voice/{voiceProfileIndex} |
| Set voice port configuration | PUT | /services/{productid}/voice/{voiceProfileIndex}/voicePorts/{voicePortIndex} |
| Reset Voice Profile | POST | /services/{productId}/voice/{voiceProfileIndex}/reset |
| Reload the voice profile and port configuration and restart all voice components | POST | /services/{productId}/voice/{voiceProfileIndex}/reconfigure |
| Reset Voice Port | POST | /services/{productId}/voice/{voiceProfileIndex}/voicePorts/{voicePortIndex}/reset |
| Set ONT admin credentials (Set Username and/or password) | PUT | /services/{productId}/security/credentials |
| Get port forwarding rules | GET | /services/{productId}/security/portForwardingRules |
| Set port forwarding rules | PUT | /services/{productId}/security/portForwardingRules |
| Get firewall configuration | GET | /services/{productId}/security/firewall |
| Set firewall configuration | PUT | /services/{productId}/security/firewall |